CD Ware Multimedia 1994 November

home *** CD-ROM | disk | FTP | other *** search

/ CD Ware Multimedia 1994 November / Cd Ware (Nro. 2) - Epimundo.iso / DOS / UD / RAR151.ZIP / RAR.DOC < prev next >

Wrap

Text File | 1994-06-19 | 35.5 KB | 1,132 lines

RAR multifunctional User's manual integrated v1.51 archive manager Welcome to the RAR Archiver! Introduction RAR is an extremely powerful tool which allows you manage and control archive files. RAR features include:- -- Full-screen interactive interface (Optional) included -- Mouse and menus -- Non-RAR archive support -- Common 'standard' command-line interface -- Highly sophisticated, original compression algorithm -- Better compression than other PC tools using 'solid' archiving -- Authenticity verification (registered version) -- Self-extracting archives, locking, password & more Chapter 1 "Installation and Configuration" This chapter describes how to install and configure RAR, as well as giving information on technical requirements. 1.1. Installation procedure RAR is distributed as a self-extracting (SFX) archive named RAR?_???.EXE where '?_???' is the version number. Installation consists of three basic steps:- .. Create a directory for the RAR files .. Make this directory the current working directory .. Execute the RAR Self-Extracting archive For example, on floppy disk A: you have the file RAR1_51.EXE, this will be RAR version 1.51. You may install it to your disk by typing, at the DOS prompt, the following commands: C:\> mkdir RAR C:\> cd RAR C:\RAR> You have now created a new directory, C:\RAR, and it is the current working directory. Then execute RAR self-extracting archive: C:\RAR> A:RAR1_51 You will be prompted with the RAR archive comment. Press any key to continue, or press ESC to cancel the extraction. When the extraction is successfully completed, a number of files will be placed in the current directory and RAR will be ready for use. The archiver program itself is named RAR.EXE. This module contains all of the archiver functionality, packing, unpacking, repairing, SFX creation etc. It is recommended that the name of the directory, containing the RAR files, be added to the PATH environment variable. This will enable RAR to be used from any directory. 1.2. Option menu A number of RAR options may be configured and saved to be used as default options. To access this menu, start RAR without any parameters and then press Function key 9 (F9) to bring up the Options menu: C:\RAR> RAR When RAR has been started, press F9 - the following menu will appear: ┌─────────────────────────────────┐ │ Configuration... │ │ Set password ALT-P │ │ Work directory ALT-W │ │ Default comment file │ │ External viewer │ │ Change disk ALT-D │ │ Registration │ │ Save options ALT-S │ └─────────────────────────────────┘ Press <Enter> for the sub-menu "Configuration". The configuration menu offers a number of basic options which may be changed. In the configuration menu, use the arrow keys to move from item to item. An item value may be changed by hitting the <space> key. When all items are set as desired, move to the "Ok" field and hit <Enter> to save the chosen values. To discard any changes, move to the "Cancel" field and hit <Enter>. If you have a mouse attached, this process is even easier. Simply move the mouse cursor to the desired item and click the left mouse key. When you've completed the configuration, move the mouse cursor to the field " Ok " and click on the left mouse key. To discard changes click the left mouse key on the " Cancel " field. "Configuration/Interface options" Color Marking this option enables colors in full-screen mode Mouse This enables the use of the mouse in full-screen mode Sound This enables RAR produce sound beeps in different situations Stdout mode This forces RAR to run in console (stdout) mode while processing commands from the command line "Configuration/Sort names" Choose the method used for sorting the archive content list from one of the following: Unsorted Do not sort names By name Sort files by name By extension Sort files by extension By size Sort files by size "Configuration/Include file mask" Choose the categories of files to be included when adding to an archive from the following: System files Add files with 'System' attribute Hidden files Add files with 'Hidden' attribute Read only files Add files with 'Read-only' attribute Archive files Add files with 'Archive' attribute Empty directories Add empty directories For more information on file attributes, please refer to your DOS manual. "Configuration/Compression" Choose the default compression level from one of the following: Store Do not compress file when adding to archive Fastest Use fastest method (least compressive) Fast Use fast compression method Normal Use normal (default) compression method Good Use good compression method (more compressive) Best Use best compression method (most compressive) "Configuration/Other options" Keep backup archive This forces RAR to save the archive file to *.BAK before it changed Add empty directories This enables add empty directories to archive Put Authenticity This forces RAR to place verification authenticity verification into archives when they are created. (This feature is only available in the registered version) Log errors to file This enables logging critical errors to file RAR.LOG. (This feature is only available in the registered version) "Set password" Assign a password which will used when you add/extract files to/from an archive. You can define the password using <Alt/P>. Note, the password will not be saved to the configuration file. "Work directory" The path where RAR will place temporary files. This may be changed at any time by pressing <Alt/W>. "Default comment file" If you would like a common comment added to every archive you are creating, enter the full path and name here. "External viewer" You may assign an external viewer program to run for viewing file in archives (by pressing <F3>). RAR stores the default configuration in the file RAR.CFG, which is held in the same directory as RAR.EXE. "Change disk" You may change the current disk displayed in the work window. "Registration" To register one must have a registration code. This code may be obtained by sending the completed registration form to your local registration site or the world-wide distribution center. You will receive the latest version of RAR in registered form along with your registration key and will then be able to create archives containing Authenticity verification. "Save setup" Pressing <Enter> or clicking the left mouse key on this item will pop up a small confirmation window in which the user is invited to " Save " or " Cancel " the saving of the new configuration for future default usage in RAR. The configuration may also be saved by pressing ALT-S keys, pressing the "S" key while simultaneously holding down the "ALT" key. These options may also be set by using the left mouse key in the window "Settings": ├────────────── Settings ─────────────╢ │ Password Absent ║ │ Compression level Normal ║ │ Archive backup Disabled ║ │ Making AV archives Enabled ║ │ Log errors to file Enabled ║ │ Default comment file Present ║ ┴─────────────────────────────────────╢ For example, click the left mouse key on the word 'Absent' in the setting 'Password', you will be prompted to enter a new password. 1.3. RAR environment variable Default parameters may be added to the RAR command line by establishing an environment variable, using the DOS "SET" command. For example: C:\> SET RAR=-std -s RAR will use this string as default parameters in the command line. RAR looks firstly to the command line switches, then to the switches in the environment variable string and finally the options saved in RAR.CFG. Switches -sfx, -v, -s, -std from RAR variable have no effect in full-screen mode. 1.4. Technical requirements Minimum DOS version to run RAR: 3.0 Version specific (for RAR 1.51) conventional memory requirements: Starting RAR: 260 Kb Extracting and viewing comments: 320 Kb Creating and updating archives: 420 Kb Managing non-RAR archives: 260 Kb (for extraction and updating non-RAR archives add the memory requirements of the external archiver) Chapter 2 "Using RAR interactively" When you execute the command "RAR" at the Dos prompt, you are presented with the full-screen interface, this is known as RAR's interactive full-screen mode. For example, you enter: C:\> RAR On the opening screen, right-hand side, you will be presented with an information box containing the memory status and settings window. This information includes: current compression method, password status (present or absent), archive back up mode, authenticity verification status (enabled/disabled), default comment file .. present or not. On the left-hand side of the screen are presented a list of files in the current directory. You can move the cursor through the files on the screen by using arrow keys or clicking the left mouse key. Pressing <Enter> when the cursor is positioned on a directory, up-directory ("..") or archive file name, will cause entry to be made to that item. The following archive types are recognized by RAR: .rar, .arj .zip, .lzh Entering an archive, causes the files within the archive to be displayed in a similar manner as a directory listing. It is therefore possible to "walk" through directories and archive files, managing files both in archives and normal directories. In "directory" mode, the bottom like of the screen contains a "menu" of functions provided by the function keys. 1Help 2Add 3View 4Fresh 5Volume 6Move 7Update 8Repair 9Option 0Quit The line indicates that you may obtain help by pressing <F1>, add files to an archive by pressing <F2>, view files by pressing <F3> etc. Press <F10> to quit. These functions are the main command set when you are in a directory (not in archive). Alternatively, pressing and holding down the <ALT> key will cause the display of additional functions: 1 2Solid 3View.. 4 5SFXVol 6SolVol 7SolSVl 8 9 0 This indicates that Pressing <ALT/F2> can be used to create a SOLID archive, <ALT/F3> to view an archive using the internal viewer, etc. Also shown, by holding down the <ALT> key, will be the options list: Alt-J DOS shell Alt-D Select drive Alt-C Toggle between color and monochrome mode Alt-M Select compression method Alt-P Set password Alt-W Set work directory to store temporary files Alt-S Save setup Pressing keys, other than those which indicate options and functions, will put RAR into speed search mode for file names. This feature can save a lot of keystrokes when looking for specific file names. Changing from a directory to an archive will automatically change the set of available functions to those which are more suitable to the circumstances. In "archive" mode the available functions line looks like: 1Help 2Test 3View 4Extr 5Commen 6ExCurD 7SFX 8Delete 9Option 0Quit This line indicates you can get help pressing <F1>, test files in archive pressing <F2>, view file by <F3> etc. Press <F10> to quit. These functions are the main set when you are in an archive. Alternatively, when holding down the <Alt> key, the following would be displayed: 1 2 3View.. 4ExtrTo 5FilCmt 6SolVol 7Lock 8 9 0 Files may be marked/unmarked by using the <Space>, <Ins>, or right mouse key. You may also mark/unmark file groups by wildcards (file mask) using the <Gray +> and <Gray -> keys on the numeric keypad. Marking a directory, automatically marks all the sub-directories and files within it. The marked/unmarked status of a group of files can be reversed by using the <Gray *> key. Marking or unmarking a file, or group of files, updates a highlighted status display line at the bottom of the screen. This status line indicates the number of files marked and the total size in bytes (the file size of marked directories does not included in the summary file size). In full-screen mode, the use of the mouse is fully supported. Use the left mouse key to move through a directory. Click the left key twice to <Enter>. Use the right key to mark files. When entering text (archive name, password etc.) the left mouse key cancels the data entry operation and right mouse key confirms entered text. Use the left mouse key to choose function commands (F1-F10) of menu items and options. 2.1. In a directory F1 Help information F2 Add file(s) to an archive, if the archive does not exist, it will be created F3 View a file (if no external viewer is set, the internal viewer will be used) F4 Freshen files in archive - only recently changed files will be added instead of their old copies in archive F5 Create archive volumes (Span diskettes) F6 Add files not already in the archive and update those files changed since they were packed to the archive F7 Move file(s) to archive F8 Repair a damaged archive F9 Set up / Save options F10 Quit RAR. Pressing the ESC key has the same effect. Alt-F2 Create a solid archive. Alt-F3 View file (with internal viewer). Alt-F5 Create Self-Extracting (SFX) volumes. Alt-F6 Create solid archive volumes. Alt-F7 Create solid SFX-volumes. 2.1. In an archive Press <Enter> with the cursor on the archive name to expand the archive contents. The same effect may be achieved with the command-line option "en". (See Chapter 3, 'en' command) Once inside an archive, the list of files is displayed on the left side of the screen. These files may be marked, just as files in a directory. An asterisk (*) to the left of a file name, indicates that the file is password encrypted. The right-hand portion of the screen is given over to an information box, which includes information on: archive name and status, comments present/absent, encrypted files, total number of files in the archive, file sizes, compression ratio, the minimum RAR version required to extract files and the host Operating System used to create the archive. For example: Info BOX: Meaning: Archive EXAMPLE.RAR - archive name Archive type Normal - not 'solid' archive Main comment Present - archive comment present File comments Absent - no individual file comments Passwords Absent - no password encrypted files Lock Absent - archive not locked Auth. verif. Present - authenticity verification present Files 1 - number of files (1) Total length 14917 - total length in bytes Packed length 3938 - length in archive Ratio 26% - compression ratio. Now 26% of original size. Version to extr. 1.50 - minimum version required to extract Host OS DOS - OS used to create this archive Function keys actions: F1 Help information F2 Test archive (validate integrity) F3 View a file (if an external viewer is not set, the internal viewer will be used) F4 Extract files from archive with directory structure F5 Add a comment to the archive F6 Extract file(s) to current directory F7 Make Self-Extracting (SFX) archive F8 Delete file(s) from archive F9 Set up / Save options F10 Quit RAR ESC Return from the archive Alt-F3 View a file (using the internal viewer) Alt-F4 Extract file(s) to an alternate path Alt-F5 Add individual file comment(s) Alt-F7 Lock the archive preventing modifications When working with archive volumes in full-screen mode you must begin the process with the first volume, you will be prompted with a menu: "Proceed with all volumes from current" "Proceed with selected files only" Choose the method you wish to use to work with the volumes. When files are displayed which were split between archive volumes, the compressed size displayed refers to the compressed size on the current volume. The symbol '' indicates that part of the file exists on a previous volume. The symbol '' indicates that part of the file exist on the next volume. Chapter 3 "The RAR command line options" Command line mode is the opposite of full-screen interactive mode. This mode is best used in batch files and requires no interaction. Usage: RAR <command> -<switch1> -<switchN> <archive> <files...> <@listfiles...> <=comment_file> <path_to_extract\> All parameters must exist on the same, single command line. command .. The function to be performed by RAR, add, extract, move etc. switch .. Switches used to define a specific type of operation, compression strength, type of archive etc. archive .. The name of the archive to be operated upon. files .. The files to be processed. listfiles .. The name of a file containing the names of the files to be operated upon. comment_file .. The name of a file containing text to be used as a comment when creating the archive. path_to_extract Used only with commands 'e' and 'x', indicating the directory in which to place extracted files. If this directory does not exist, it will be created. 3.1. Commands (Alphabetic sequence) .. a: add files to archive .. c: add archive comment Pressing <F10> will save the entered comment and exit. Pressing <Esc> will cancel the comment. Pressing <F10> without entering a comment will remove any existing comment. Comments are displayed while the archive is being processed. The maximum comment length is 16384 bytes. Support for ANSI esc-sequences is provided in RAR which allows the use of colour and cursor movements. No ANSI driver is required to display such comments. Redefinition of the keyboard using ANSI esc-sequences is NOT supported and thus the so-called ANSI-bombs cannot be delivered using RAR. Example: rar c distrib.rar Comments may be entered from a file by using the '=' switch before the name of the file containing the comment. rar c dummy =info.txt .. cf: add file comments (not to entire archive) Pressing <F10> will save the entered comment and exit. Pressing <Esc> will cancel the comment. Pressing <F10> without entering a comment will remove any existing comment. Comments are displayed when the 'v' command is given. Comment length is limited to 16384 bytes. Example: rar cf bigarch *.txt .. cw: write the archive comment to a file For example: rar cw oldarch comment.txt The comment from the archive oldarch.rar will be written to the file comment.txt .. d: delete files from archive .. e: extract files from archive to current directory .. en: start RAR in full-screen mode and enter an archive Usually this command is included in the extension file of a shell processor such as Norton Commander: RAR: RAR en !.! Examples: rar en disk1.rar rar en puppy.zip The 'en' may also be omitted, simply start RAR with the archive name. Example: rar baby.arj .. f: freshen files in archive Updates those files changed since they were packed to the archive. This command will not add new files to the archive. .. k: lock archive Any commands that could change the archive will be ignored. Example: rar k final.rar .. l: list archive contents (brief listing) Files are listed as with the 'v' command with the exception of the file path. i.e. only the file name is displayed. .. m: move files and directories to archive Moving files and directories results in the files and directories being erased upon successful completion of the packing operation. Directories will not be removed if '-ed' switch is used. .. mf: move files to archive Moving files results in the files being erased upon successful completion of the packing operation. .. p: print file(s) to screen (STDOUT) .. r: repair damaged archive RAR cannot restore lost information, so it is not possible to recover files which fail the CRC validation, but it is possible to recover files which may still exist in the archive undamaged. When this command has completed, a new archive will be created, called $RECOVER.RAR While the recovery process is in operation, RAR will prompt the user for assistance when suspicious files are located. Suspicious entry Name: <possibly filename> Size: <size> Packed: <compressed size> Add it: Yes/No/All Answer 'Y' to add this entry to the file $RECOVER.RAR. Example: rar r buggy.rar .. s: convert archive to a Self-Extracting (SFX) type. In the Dos environment, this will create a *.EXE file which, when executed, will extract the files contained within it. It is also possible to make an SFX archive as the first of a multi-volume sequence, but it should be noted that the size will be larger by the amount of the SFX-module. Please ensure that the first volume in the sequence is created with the correct size. SFX volumes may be created using the command 'a' with the switches: '-v[<size>] -sfx' For example: rar s diamant .. t: test archive files This command performs a dummy file extraction, writing nothing to the output stream, in order to validate the specified file(s). .. u: update files in archive Adds files not already in the archive and updates those files changed since they were packed to the archive. .. v: verbosely list archive content (full listing) Files are listed using the format: full pathname, file comment, original and compressed size, compression ratio, last update date and time, attributes, CRC, compression method and minimum RAR version required to extract. To list the contents of all archive volumes, use and asterisk (*) in place of the archive file extension. For example: rar v multivol.* .. x: extract files from archive to original (relative) directory if pathnames exist in the archive Command limitations: The commands 'd','u','f' will not operate with archive volumes and solid archives. The command 'a' cannot be used to update an archive volume or a solid archives, only to create one. The commands 'c' and 'cf' will not operate with archive volumes, but will work with solid archives. An archive comment can be added when the archive is created using a comment file. 3.2. Switches (Alphabetic sequence) .. -? display help on commands and switches .. -av put authenticity verification (registered versions only!) RAR will put, in every new and updated archive, information concerning the creator, last update time and archive name. If an archive, containing authenticity verification, is being modified and this switch is not specified, the authenticity verification information will be removed. When extracting, testing, listing or updating and archive with the '-av' switch, RAR will perform integrity validation display the message: Verifying authenticity information ... In the case of successful authenticity verification, the message 'Ok', creator name and last update information will be displayed. In the case of authenticity verification failure, the message 'FAILED' will be displayed. When creating archive volumes with the '-av' switch, Cyclic Redundancy Check (CRC) information will be added to each volume. The Authenticity Verification feature, '-av,' is recommended for use with archives in a software distribution environment. In order to enable the Authenticity verification feature, the program MUST be registered. Please contact your local distribution site or the world-wide distribution center. .. -b enable backup archives This switch will create a backup before an archive is modified. The backup file will have the same name as the original archive but with the .BAK extension. Should this file already exist, the backup file will be named with a .$BK extension. .. -bw black & white (monochrome) mode .. -c- disable comments show .. -cfg- disable read configuration and environment .. -col colour mode .. -e<s,h,a,r> set file exclusion attributes The switches 's', 'h', 'a' or 'r' signify that files having the System, Hidden, Archive or Read only attributes should be excluded. The order in which the attributes are given is not significant. Example: rar a -ehs purity *.exe Do NOT add files with Hidden or System attributes. .. -ed don't add empty directories This switch indicates that empty directories are not to be stored in the created archive. .. -ep exclude paths from names This switch enables files to be added to an archive without including the path information. This could, of course, result in multiple files existing in the archive with the same name. .. -ep1 exclude base dir from names Do not store the path from the command line. Example: rar a -ep1 -r pasta tmp\*.* All files and directories from the directory TMP will be added to the archive 'pasta', but the path will not include 'TMP\'. This is equivalent to the commands: cd tmp rar a -ep1 -r pasta cd .. For correct operation of this switch you must use the full form of the path, as given in the example above, and NOT the command string: rar a -ep1 -r pasta tmp .. -f freshen files May be used with archive extraction or creation. The command string "a -f" is equivalent to the command 'f', you could also use the switch '-f' with the commands 'm' or 'mf'. If the switch '-f' is used with the commands 'x' or 'e', then only old files would be replaced with new versions extracted from the archive. .. -m<0..5> set compression method -m0 store do not compress file when adding to archive -m1 fastest use fastest method (less compressive) -m2 fast use fast compression method -m3 normal use normal (default) compression method -m4 good use good compression method (more compressive) -m5 best use best compression method By default RAR uses -m3 method (Normal compression). .. -o+ overwrite existing files .. -o- do not overwrite existing files (default) .. -p set password The password is case-sensitive. If you omit the password on the command line, you will be prompted with: Enter password: Example: rar a -pmyhoney secret *.txt Newly added files will be encrypted with the password 'myhoney'. .. -p<password> set password .. -r recurse subdirectories May be used with commands: a,u,f,m,x,e,t,p,v,l,c,cf,s. When used with the commands 'a', 'u', 'f', 'm' will process files in all sub-directories as well as the current working directory. When used with the commands x,e,t,p,v,l,c,cf,s will process all archives in sub-directories as well as the current working directory. .. -s create solid archive Solid is special archive type. Please refer to the appendix "Glossary" for further information. Example: rar a -s -v1440 -sfx maddy *.* Will create solid Self-Extracting (SFX) volumes of size 1440000 bytes. .. -sfx create Self-Extracting (SFX) archive If this switch is used when creating a new archive, a Self-Extracting archive would be created. Example: rar a -sfx sources *.asm This command would create a Self-Extracting archive named SOURCES.EXE. To extract files from such an archive, you would simply execute it. Self-Extracting archives may be processed normally using RAR. .. -std stdout mode All output text is sent to the stdout stream. This allows redirection of RAR output to a file, for example: rar v -std bambam >bambam.lst or you could process without any output: rar x -std dime 10cents.txt >nul .. -u update files May be used with archive extraction or creation. The command string "a -u" is equivalent to the command 'u', you could also use the switch '-u' with the commands 'm' or 'mf'. If the switch '-u' is used with the commands 'x' or 'e', then files not present on the disk and files newer than their copies on the disk would extracted from the archive. .. -v create volumes with autodetected size .. -v<size> create archive volumes By default this switch uses <size> as thousands of bytes (not 1024 x bytes). You may also enter the size in kilobytes using the symbol 'k' following the numerical value. If the size is omitted, autodetection will be used. If volumes are created on the same drive as the temporary files (current drive by default, but may be changed with the switch '-w'), the autodetected size becomes meaningless. In this case the volume size must be explicitly defined. If volumes are created on a drive OTHER than the drive containing the temporary files, then after the first volume has been created, the user will be prompted with: Create next volume: Yes/No/All/Quit At this moment in time, you should change the disks. Answering 'A' will cause all volumes to be created without a pause. The first volume file in a multi-volume set has the extension .RAR, following volumes are numbered from .R00 to .R99. When extracting or testing a multi-volume archive you must use only the first volume name (*.RAR). If there is no next volume on the drive (and volumes are not placed in the same directory as the temporary files), the user will prompted with: Insert disk with <next volume name> Insert the disk with the correct volume and press any key. If while extracting, the next volume is not found and volumes are placed in the same directory as the temporary files, RAR will abort with the error message: Can't find <volume name> Can't change disk with temporary files Archive volumes may not be modified. The commands 'd', 'f', 'u', 's' can not be used with Multi-volume sets. The command 'a' may be used only for the creation of a new multi-volume sequence. It is possible, although unlikely, that the file size, of a file in a multi-volume set, could be greater than it's uncompressed size. This is due to the fact that 'storing' (no compression if size increases) cannot be enabled for multi-volume sets. Archive volumes may be Self-Extracting (SFX). Such an archive should be created using both the '-v' and '-sfx' switches. Example: 1. Archive drive C: on floppy drive A: rar a -r -v a:allhard c:\*.* (current disk MUST be C:) 2. Create archive volumes with 1440000 byte size in current directory. rar a -v1440 4flopp or rar a -v1440 4flopp *.* .. -w<path> assign work directory This switch may be used to assign the directory for temporary files to another drive. For example a RAM drive or high performance disc. Note, if temporary files cannot be created in the current directory, RAR will search for an available disk automatically. Example: rar a -we:\tmp bmps *.bmp Temporary files would be created in directory E:\TMP .. -x<mask> exclude files specified by mask Example: rar a -x*.bak purearch.rar .. -x@<list> exclude files using specified list file Example: rar a -x@exlist.txt arch *.exe .. -y assume Yes on all queries Glossary Archive Special file containing one or more files optionally encoded and/or compressed. Compression A method of encoding data to reduce it's size. CRC Cyclic Redundancy Check. Mathematic method calculating special checking information for data validity. SFX Archive module used to extract files from when executed. (SelF-eXtracting module), usually in the form of a .EXE file. Solid An archive packed using a special compression method which sees all files as one continuous data stream. Particularly advantageous when packing a large number of small files. Volume Part of a split archive. Splitting an archive to volumes allows storing them on diskettes. Volumes must be extracted starting from first in sequence.